.TH "src/consoleParser/consoleParser.c" 3 "Thu Oct 11 2012" "Version 1.0" "Dissasemble" \" -*- nroff -*-
.ad l
.nh
.SH NAME
src/consoleParser/consoleParser.c \- 
.SH SYNOPSIS
.br
.PP
\fC#include 'consoleParser\&.h'\fP
.br
\fC#include <debug\&.h>\fP
.br

.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBtsConsoleInput\fP"
.br
.RI "\fIStructure containing the different program process\&. \fP"
.in -1c
.SS "Functions"

.in +1c
.ti -1c
.RI "void \fBprintHelp\fP ()"
.br
.RI "\fIPrints menu options\&. \fP"
.ti -1c
.RI "char \fBvalidateInput\fP (char *\fBpArg\fP)"
.br
.RI "\fIValidates the input arguments, to verify whether they correspond to a valid program option\&. \fP"
.ti -1c
.RI "char \fBprocessArgs\fP (int argc, char *argv[], char **\fBpArgFiles\fP, char *\fBpArg\fP)"
.br
.RI "\fIA process that divides the entry list into commands and arguments to be used in the program execution\&. \fP"
.ti -1c
.RI "char \fBparseConsoleInput\fP (int argc, char *argv[], char **\fBpArgFiles\fP, char *\fBpArg\fP)"
.br
.RI "\fIParse the arguments entered as input to identify the file name and the commands to be executed\&. Validating ever input command\&. \fP"
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "char \fBinputCommandArgs\fP [\fBMAX_INPUT_ARGS\fP]"
.br
.RI "\fIArray containing incoming commands\&. \fP"
.ti -1c
.RI "char \fBinputArgList\fP [\fBMAX_INPUT_ARGS\fP]"
.br
.RI "\fIArray containing the list of arguments for the application execution\&. \fP"
.ti -1c
.RI "unsigned char \fBnumberInputCommands\fP = 0"
.br
.RI "\fINumber of input commands\&. \fP"
.ti -1c
.RI "unsigned char \fBnumberInputArgs\fP = 0"
.br
.RI "\fINumber of input arguments\&. \fP"
.ti -1c
.RI "\fBtsConsoleInput\fP \fBinputCommands\fP []"
.br
.RI "\fIArray containing the input commands\&. \fP"
.in -1c
.SH "Function Documentation"
.PP 
.SS "\fBparseConsoleInput\fP (intargc, char *argv[], char **pArgFiles, char *pArg)"
.PP
Parse the arguments entered as input to identify the file name and the commands to be executed\&. Validating ever input command\&. \fBParameters:\fP
.RS 4
\fIargc\fP Number of arguments\&. 
.br
\fIarg[]\fP Array of arguments\&. 
.br
\fIpArgFiles\fP Name File argument 
.br
\fIpArg\fP Commands 
.RE
.PP

.SS "void \fBprintHelp\fP ()"
.PP
Prints menu options\&. 
.SS "\fBprocessArgs\fP (intargc, char *argv[], char **pArgFiles, char *pArg)"
.PP
A process that divides the entry list into commands and arguments to be used in the program execution\&. \fBParameters:\fP
.RS 4
\fIargc\fP Number of arguments\&. 
.br
\fIarg[]\fP Incoming argument array 
.br
\fIpArgFiles\fP Name File argument 
.br
\fIpArg\fP Input commands 
.RE
.PP

.SS "char char \fBvalidateInput\fP (char *pArg)"
.PP
Validates the input arguments, to verify whether they correspond to a valid program option\&. \fBParameters:\fP
.RS 4
\fIpArg\fP Argument to validate\&. 
.RE
.PP

.SH "Variable Documentation"
.PP 
.SS "char \fBinputArgList\fP[\fBMAX_INPUT_ARGS\fP]"
.PP
Array containing the list of arguments for the application execution\&. 
.SS "char \fBinputCommandArgs\fP[\fBMAX_INPUT_ARGS\fP]"
.PP
Array containing incoming commands\&. 
.SS "\fBtsConsoleInput\fP \fBinputCommands\fP[]"\fBInitial value:\fP
.PP
.nf

{
{ HEADER_DUMP, 'Prints the headers name of the file\n', 0 },
{ RAW_DUMP, 'Hex dump of the file\n', 0 },
{ PROCESS_HEADER_CONTENT, 'Prints the content of each header\n', 0 },
{ 0, 0, 0 } }
.fi
.PP
Array containing the input commands\&. 
.SS "unsigned char \fBnumberInputArgs\fP = 0"
.PP
Number of input arguments\&. 
.SS "unsigned char \fBnumberInputCommands\fP = 0"
.PP
Number of input commands\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for Dissasemble from the source code\&.
